<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: StorageIdGenerator.html 842 2015-03-07 18:20:42Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.lang.reflect.Method;<a name="line.10"></a>
<span class="sourceLineNo">011</span><a name="line.11"></a>
<span class="sourceLineNo">012</span>/**<a name="line.12"></a>
<span class="sourceLineNo">013</span> * Used to auto-generate storage ID's for Java model classes, fields, and composite indexes when not specified<a name="line.13"></a>
<span class="sourceLineNo">014</span> * explicitly in the corresponding {@link org.jsimpledb.annotation.JSimpleClass &amp;#64;JSimpleClass},<a name="line.14"></a>
<span class="sourceLineNo">015</span> * {@link org.jsimpledb.annotation.JField &amp;#64;JField}, etc., annotations.<a name="line.15"></a>
<span class="sourceLineNo">016</span> *<a name="line.16"></a>
<span class="sourceLineNo">017</span> * @see JSimpleDBFactory#setStorageIdGenerator JSimpleDBFactory.setStorageIdGenerator()<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>public interface StorageIdGenerator {<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>    /**<a name="line.21"></a>
<span class="sourceLineNo">022</span>     * Generage a storage ID for a Java model class.<a name="line.22"></a>
<span class="sourceLineNo">023</span>     *<a name="line.23"></a>
<span class="sourceLineNo">024</span>     * @param type Java model class<a name="line.24"></a>
<span class="sourceLineNo">025</span>     * @param typeName database type name<a name="line.25"></a>
<span class="sourceLineNo">026</span>     * @return generated storage ID<a name="line.26"></a>
<span class="sourceLineNo">027</span>     */<a name="line.27"></a>
<span class="sourceLineNo">028</span>    int generateClassStorageId(Class&lt;?&gt; type, String typeName);<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>    /**<a name="line.30"></a>
<span class="sourceLineNo">031</span>     * Generage a storage ID for a composite index.<a name="line.31"></a>
<span class="sourceLineNo">032</span>     *<a name="line.32"></a>
<span class="sourceLineNo">033</span>     * @param type Java model class containing the indexed fields<a name="line.33"></a>
<span class="sourceLineNo">034</span>     * @param name composite index name<a name="line.34"></a>
<span class="sourceLineNo">035</span>     * @param fields indexed field storage ID's in index order<a name="line.35"></a>
<span class="sourceLineNo">036</span>     * @return generated storage ID<a name="line.36"></a>
<span class="sourceLineNo">037</span>     */<a name="line.37"></a>
<span class="sourceLineNo">038</span>    int generateCompositeIndexStorageId(Class&lt;?&gt; type, String name, int[] fields);<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>    /**<a name="line.40"></a>
<span class="sourceLineNo">041</span>     * Generage a storage ID for a regular field.<a name="line.41"></a>
<span class="sourceLineNo">042</span>     *<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * @param getter the field's Java bean getter method<a name="line.43"></a>
<span class="sourceLineNo">044</span>     * @param name the field's database name<a name="line.44"></a>
<span class="sourceLineNo">045</span>     * @return generated storage ID<a name="line.45"></a>
<span class="sourceLineNo">046</span>     */<a name="line.46"></a>
<span class="sourceLineNo">047</span>    int generateFieldStorageId(Method getter, String name);<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span>    /**<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * Generage a storage ID for a set field.<a name="line.50"></a>
<span class="sourceLineNo">051</span>     *<a name="line.51"></a>
<span class="sourceLineNo">052</span>     * @param getter the field's Java bean getter method<a name="line.52"></a>
<span class="sourceLineNo">053</span>     * @param name the field's database name<a name="line.53"></a>
<span class="sourceLineNo">054</span>     * @return generated storage ID<a name="line.54"></a>
<span class="sourceLineNo">055</span>     */<a name="line.55"></a>
<span class="sourceLineNo">056</span>    int generateSetElementStorageId(Method getter, String name);<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span>    /**<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * Generage a storage ID for a list field.<a name="line.59"></a>
<span class="sourceLineNo">060</span>     *<a name="line.60"></a>
<span class="sourceLineNo">061</span>     * @param getter the field's Java bean getter method<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * @param name the field's database name<a name="line.62"></a>
<span class="sourceLineNo">063</span>     * @return generated storage ID<a name="line.63"></a>
<span class="sourceLineNo">064</span>     */<a name="line.64"></a>
<span class="sourceLineNo">065</span>    int generateListElementStorageId(Method getter, String name);<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span>    /**<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * Generage a storage ID for a map key field.<a name="line.68"></a>
<span class="sourceLineNo">069</span>     *<a name="line.69"></a>
<span class="sourceLineNo">070</span>     * @param getter the field's Java bean getter method<a name="line.70"></a>
<span class="sourceLineNo">071</span>     * @param name the field's database name<a name="line.71"></a>
<span class="sourceLineNo">072</span>     * @return generated storage ID<a name="line.72"></a>
<span class="sourceLineNo">073</span>     */<a name="line.73"></a>
<span class="sourceLineNo">074</span>    int generateMapKeyStorageId(Method getter, String name);<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span>    /**<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * Generage a storage ID for a map value field.<a name="line.77"></a>
<span class="sourceLineNo">078</span>     *<a name="line.78"></a>
<span class="sourceLineNo">079</span>     * @param getter the field's Java bean getter method<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * @param name the field's database name<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * @return generated storage ID<a name="line.81"></a>
<span class="sourceLineNo">082</span>     */<a name="line.82"></a>
<span class="sourceLineNo">083</span>    int generateMapValueStorageId(Method getter, String name);<a name="line.83"></a>
<span class="sourceLineNo">084</span>}<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>




























































</pre>
</div>
</body>
</html>
